Room使用介绍

简介

在2017年Google IO大会上推出的官方数据框框架,其实际上就是对SQLite做了一层封装。基本原理是通过编译期注解,根据你配置的表名和表字段生成对应的代码,减少开发者的工作量。

使用

1、添加Room依赖

dependencies {
 api "android.arch.persistence.room:runtime:$1.1.1"
 annotationProcessor "android.arch.persistence.room:compiler:$1.1.1"
}

注意,如果你是将room封装在module里面,然后再将module引入到主工程的话,需要将 annotationProcessor "android.arch.persistence.room:compiler:$1.1.1" 这个也拷贝到主工程的build.gradle里面,要不然注解不能够正常生成,项目也运行不起来。

2、使用

在使用的过程中,我们需要一个Entity、一个Dao和一个DataBase。

1)、Entry类
使用@Entity注解,表名这个是其中一张表,另外,如果在属性的签名不加任何注解的话,这个属性就是一个字段名,当然,如果你不想直接使用属性名作为字段名的话,可以加上 @ColumnInfo(name = "message")进行自定义。如果这个实体类的某个字段不想存进数据库的话,可以加上@Ingore.是否是主键、外键等也有对应的注解。

@Entity(tableName = RoomConstant.FIRST_TABLE)
public class FirstTable {

    @PrimaryKey(autoGenerate = true)
    private int id;

    @ColumnInfo(name = "message")
    private String message;

    public String getInfo() {
        return info;
    }

    public void setInfo(String info) {
        this.info = info;
    }

    @ColumnInfo(name = "info")
    private String info;

    public void setMessage(String message){
        this.message = message;
    }

    public int getId() {
        return id;
    }

    public String getMessage() {
        return message;
    }

    public void setId(int id) {
        this.id = id;
    }
}

2)、Dao 类
这个类的作用是配置对应的数据库操作方法,比如查询、更新、删除等,注意,类名前面需要@Dao注解。如果是全部查询、删除等操作,可以直接传入对应的entry类,如果是根据某个字段去查询,需要自己写对应的sql语句。

@Dao
public interface BaseDao<T> {

    @Insert
    void insertItem(T item);//插入单条数据

    @Insert
    void insertItems(List<T> items);//插入list数据

    @Delete
    void deleteItem(T item);//删除item

    @Update
    void updateItem(T item);//更新item
}

@Dao
public interface FistTableDao extends BaseDao<FirstTable>{

    //如果是查询

    @Query("SELECT * FROM first_table")
    List<FirstTable> getAll();

    @Query("SELECT * FROM first_table WHERE id IN (:ids)")
    List<FirstTable> loadAllByIds(int[] ids);

    @Query("SELECT * FROM first_table WHERE :message LIKE :message")
    FirstTable findByMessage(String message);
}

3)、DataBase类
使用@DataBase注解。里面需要配置你要操作的entry类,可以配置一个或者多个,version表名这个是哪个版本,如果升级需要修改的就是这里。升级的策略有两种,一种是完全不要旧版本的数据,增加fallbackToDestructiveMigration即可,如果有自定义的升级策略....后面再讲。allowMainThreadQueries表明是否可以在主线程进行操作,一般不建议增加这个配置。配置abstract FistTableDao userDao(); 就可以获取到进行数据库操作的实例。

@Database(entities = {FirstTable.class, SecondTable.class, ThirdTable.class}, version = RoomConstant.VERSION, exportSchema = false)
public abstract class MyRoomDataBase extends RoomDatabase {

    private static MyRoomDataBase mInstance;

    public static MyRoomDataBase getInstance(Context context) {
        if (mInstance == null) {
            synchronized (MyRoomDataBase.class) {
                if (mInstance == null) {
                    mInstance = Room.databaseBuilder(context, MyRoomDataBase.class, DB_NAME)
                            .fallbackToDestructiveMigration() //直接删除旧版数据
                            .allowMainThreadQueries()   //可以在主线程操作
                            .build();
                }
            }
        }
        return mInstance;
    }

    public static void onDestroy() {
        mInstance = null;
    }

    public abstract FistTableDao userDao();

    public abstract SecondTableDao secondTableDao();

    public abstract ThirdTableDao thirdTableDao();
}

3、设置 Schema 的位置

存储展示数据库的结构信息,如果不设置的话,需要再database类上配置exportSchema = false,要不然编译的时候会出现警告。

defaultConfig {
        minSdkVersion 19
        targetSdkVersion 26

        javaCompileOptions {
            annotationProcessorOptions {
                arguments =["room.schemaLocation":"$projectDir/schemas".toString()]
            }
        }
}

4、查询

经过上面的配置之后,就可以获取到对应的Dao实例进行操作,

MyRoomDataBase myRoomDataBase = MyRoomDataBase.getInstance(baseContext);

    private static void operateFristTable(MyRoomDataBase myRoomDataBase) {
        FistTableDao fistTableDao = myRoomDataBase.userDao();
        FirstTable firstTable = new FirstTable();
        firstTable.setMessage("firstTableMessage1");
        firstTable.setInfo("第一个表");
        fistTableDao.insertItem(firstTable);

//        firstTable.delete(firstTable);

        FirstTable item  = fistTableDao.findByMessage("firstTableMessage1");
        if (item != null) {
            Log.d(TAG, item.getInfo());
        }

        List<FirstTable> firstTableList = fistTableDao.loadAllByIds(new int[]{0,1,2});

        if (firstTableList != null) {
            Log.d(TAG, "<-firstTableSize->" + firstTableList.size());
        }
    }

5、升级

如果需要进行数据库的升级,需要再构造database 实例的时候,调用addMigrations进行配置

Room.databaseBuilder(getApplicationContext(),  MyRoomDataBase.class,  DB_NAME).  (MIGRATION_1_2, MIGRATION_2_3).build();

static final Migration MIGRATION_1_2 = new Migration(1, 2) {
    @Override
    public void migrate(SupportSQLiteDatabase database) {
        database.execSQL("CREATE TABLE `second_table` (`id` INTEGER, "
                + "`name` TEXT, PRIMARY KEY(`id`))");
    }
};

static final Migration MIGRATION_2_3 = new Migration(2, 3) {
    @Override
    public void migrate(SupportSQLiteDatabase database) {
        database.execSQL("alert table first_table "
                + "add column age integer");
    }
};
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,458评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,454评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,171评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,062评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,440评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,661评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,906评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,609评论 0 200
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,379评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,600评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,085评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,409评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,072评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,088评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,860评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,704评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,608评论 2 270

推荐阅读更多精彩内容

  • 持久库Room Room在SQLite上提供了一个抽象层,以便在利用SQLite的全部功能的同时使流畅的数据库访问...
    _番茄沙司阅读 8,272评论 4 23
  • Room是一个对象关系映射(ORM)库。Room抽象了SQLite的使用,可以在充分利用SQLite的同时访...
    tuacy阅读 53,666评论 16 109
  • Room持久性库在SQLite的基础上提供了一个抽象层,允许流利的数据库访问,同时利用的SQLite的全部力量。该...
    yyg阅读 5,253评论 0 5
  • 26 乔治修拉 修拉的绘画风格和们之前所看到的有很大的不同,主要原因是他钟情于制造大块的形状,进而将画面削减全单纯...
    咔辣辣阅读 425评论 0 0
  • 亲爱的老婆! 我们结婚在一起生活了十七年,你跟着我一起吃了很多的苦,受了很多的委屈,我的心里真的感到非常难过! 过...
    一峰阅读 1,131评论 15 9